home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 April: Mac OS SDK / Dev.CD Apr 99 SDK1.toast / Development Kits / Interfaces&Libraries / Universal / Interfaces / AIncludes / QD3DExtension.a < prev    next >
Encoding:
Text File  |  1998-08-17  |  8.6 KB  |  316 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        QD3DExtension.a
  3. ;
  4. ;    Contains:    QuickDraw 3D Plug-in Architecture     Interface File.                                
  5. ;
  6. ;    Version:    Technology:    Quickdraw 3D 1.5.4
  7. ;                Release:    Universal Interfaces 3.2
  8. ;
  9. ;    Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__QD3DEXTENSION__') = 'UNDEFINED' THEN
  18. __QD3DEXTENSION__ SET 1
  19.  
  20.     IF &TYPE('__QD3D__') = 'UNDEFINED' THEN
  21.     include 'QD3D.a'
  22.     ENDIF
  23.     IF &TYPE('__QD3DERRORS__') = 'UNDEFINED' THEN
  24.     include 'QD3DErrors.a'
  25.     ENDIF
  26.  
  27. ; ******************************************************************************
  28. ; **                                                                             **
  29. ; **                                Constants                                      **
  30. ; **                                                                             **
  31. ; ****************************************************************************
  32.  
  33.     IF TARGET_OS_MAC THEN
  34.  
  35. kQ3XExtensionMacCreatorType        EQU        'Q3XT'
  36. kQ3XExtensionMacFileType        EQU        'shlb'
  37.     ENDIF    ; TARGET_OS_MAC
  38.  
  39. ; ******************************************************************************
  40. ; **                                                                             **
  41. ; **                                Object Method types                              **
  42. ; **                                                                             **
  43. ; ****************************************************************************
  44.  
  45.  
  46. kQ3XMethodTypeObjectClassVersion EQU    'vrsn'
  47. ; typedef unsigned long                 TQ3XObjectClassVersion
  48.  
  49.  
  50. kQ3XMethodTypeObjectClassRegister EQU    'rgst'
  51.  
  52. kQ3XMethodTypeObjectClassReplace EQU    'rgrp'
  53.  
  54. kQ3XMethodTypeObjectClassUnregister EQU    'unrg'
  55.  
  56. kQ3XMethodTypeObjectNew            EQU        'newo'
  57.  
  58. kQ3XMethodTypeObjectDelete        EQU        'dlte'
  59.  
  60. kQ3XMethodTypeObjectDuplicate    EQU        'dupl'
  61. ; ******************************************************************************
  62. ; **                                                                             **
  63. ; **                            Object Hierarchy Registration                      **
  64. ; **                                                                             **
  65. ; ****************************************************************************
  66.  
  67. ; 
  68. ; *    Q3XObjectHierarchy_RegisterClass
  69. ; *    
  70. ; *    Register an object class in the QuickDraw 3D hierarchy.
  71. ; *    
  72. ; *    parentType            - an existing type in the hierarchy, or 0 to subclass
  73. ; *                            TQ3Object
  74. ; *    objectType            - the new object class type, used in the binary 
  75. ; *                        metafile.  This is assigned at run time and returned
  76. ; *                          to you.
  77. ; *    objectName            - the new object name, used in the text metafile
  78. ; *    metaHandler            - a TQ3XMetaHandler (may be NULL for some classes) 
  79. ; *                          which returns non-virtual methods
  80. ; *    virtualMetaHandler    - a TQ3XMetaHandler (may be NULL as well) which returns
  81. ; *                            virtual methods a child would inherit
  82. ; *    methodsSize            - the size of the class data needed (see 
  83. ; *                            GetClassPrivate calls below)
  84. ; *    instanceSize        - the size of the object instance data needed (see 
  85. ; *                            GetPrivate calls below)
  86. ; 
  87.  
  88. ;
  89. ; extern TQ3XObjectClass Q3XObjectHierarchy_RegisterClass(TQ3ObjectType parentType, TQ3ObjectType *objectType, char *objectName, TQ3XMetaHandler metaHandler, TQ3XMetaHandler virtualMetaHandler, unsigned long methodsSize, unsigned long instanceSize)
  90. ;
  91.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  92.         IMPORT_CFM_FUNCTION Q3XObjectHierarchy_RegisterClass
  93.     ENDIF
  94.  
  95. ; 
  96. ; *    Q3XObjectHierarchy_UnregisterClass
  97. ; *    
  98. ; *    Returns kQ3Failure if the objectClass still has objects 
  99. ; * around; the class remains registered.
  100. ; 
  101.  
  102. ;
  103. ; extern TQ3Status Q3XObjectHierarchy_UnregisterClass(TQ3XObjectClass objectClass)
  104. ;
  105.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  106.         IMPORT_CFM_FUNCTION Q3XObjectHierarchy_UnregisterClass
  107.     ENDIF
  108.  
  109. ; 
  110. ; *    Q3XObjectHierarchy_GetMethod
  111. ; *    
  112. ; *    For use in TQ3XObjectClassRegisterMethod call
  113. ; 
  114.  
  115. ;
  116. ; extern TQ3XFunctionPointer Q3XObjectClass_GetMethod(TQ3XObjectClass objectClass, TQ3XMethodType methodType)
  117. ;
  118.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  119.         IMPORT_CFM_FUNCTION Q3XObjectClass_GetMethod
  120.     ENDIF
  121.  
  122. ; 
  123. ; *    Q3XObjectHierarchy_NewObject
  124. ; *    
  125. ; *    To create a new object. Parameters is passed into the 
  126. ; *    TQ3XObjectNewMethod as the "parameters" parameter.
  127. ; 
  128.  
  129. ;
  130. ; extern TQ3Object Q3XObjectHierarchy_NewObject(TQ3XObjectClass objectClass, void *parameters)
  131. ;
  132.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  133.         IMPORT_CFM_FUNCTION Q3XObjectHierarchy_NewObject
  134.     ENDIF
  135.  
  136. ; 
  137. ; *    Q3XObjectClass_GetLeafType
  138. ; *    
  139. ; *    Return the leaf type of a class.
  140. ; 
  141.  
  142. ;
  143. ; extern TQ3ObjectType Q3XObjectClass_GetLeafType(TQ3XObjectClass objectClass)
  144. ;
  145.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  146.         IMPORT_CFM_FUNCTION Q3XObjectClass_GetLeafType
  147.     ENDIF
  148.  
  149. ; 
  150. ; *    Q3XObjectClass_GetVersion
  151. ; *    This routine obtains the the version of a class, referenced by an
  152. ; *    object class type.  Functions for getting the type are in QD3D.h,
  153. ; *    if you have the class name.
  154. ; 
  155.  
  156. ;
  157. ; extern TQ3Status Q3XObjectHierarchy_GetClassVersion(TQ3ObjectType objectClassType, TQ3XObjectClassVersion *version)
  158. ;
  159.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  160.         IMPORT_CFM_FUNCTION Q3XObjectHierarchy_GetClassVersion
  161.     ENDIF
  162.  
  163. ; 
  164. ; *    Q3XObjectClass_GetType 
  165. ; *
  166. ; *    This can be used to get the type, given a reference 
  167. ; *    to a class.  This is most useful in the instance where you register a 
  168. ; *    an element/attribute and need to get the type.  When you register an
  169. ; *    element, QD3D will take the type you pass in and modify it (to avoid
  170. ; *    namespace clashes).  Many object system calls require an object type
  171. ; *    so this API call allows you to get the type from the class referernce
  172. ; *    that you will ordinarily store when you register the class.
  173. ; 
  174.  
  175. ;
  176. ; extern TQ3Status Q3XObjectClass_GetType(TQ3XObjectClass objectClass, TQ3ObjectType *theType)
  177. ;
  178.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  179.         IMPORT_CFM_FUNCTION Q3XObjectClass_GetType
  180.     ENDIF
  181.  
  182.  
  183. ;
  184. ; extern TQ3XObjectClass Q3XObjectHierarchy_FindClassByType(TQ3ObjectType theType)
  185. ;
  186.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  187.         IMPORT_CFM_FUNCTION Q3XObjectHierarchy_FindClassByType
  188.     ENDIF
  189.  
  190.  
  191.  
  192. ; 
  193. ; *    Q3XObjectClass_GetPrivate
  194. ; *    
  195. ; *    Return a pointer to private instance data, a block of instanceSize bytes, 
  196. ; *    from the Q3XObjectHierarchy_RegisterClass call.
  197. ; *    
  198. ; *    If instanceSize was zero, NULL is always returned.
  199. ; 
  200.  
  201. ;
  202. ; extern void *Q3XObjectClass_GetPrivate(TQ3XObjectClass objectClass, TQ3Object targetObject)
  203. ;
  204.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  205.         IMPORT_CFM_FUNCTION Q3XObjectClass_GetPrivate
  206.     ENDIF
  207.  
  208. ; 
  209. ; * Return the "TQ3XObjectClass" of an object
  210. ; 
  211.  
  212. ;
  213. ; extern TQ3XObjectClass Q3XObject_GetClass(TQ3Object object)
  214. ;
  215.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  216.         IMPORT_CFM_FUNCTION Q3XObject_GetClass
  217.     ENDIF
  218.  
  219.  
  220.  
  221. ; ******************************************************************************
  222. ; **                                                                             **
  223. ; **                    Shared Library Registration Entry Point                      **
  224. ; **                                                                             **
  225. ; ****************************************************************************
  226.  
  227. TQ3XSharedLibraryInfo    RECORD 0
  228. registerFunction         ds.l    1                ; offset: $0 (0)
  229. sharedLibrary             ds.l    1                ; offset: $4 (4)
  230. sizeof                     EQU *                    ; size:   $8 (8)
  231.                         ENDR
  232. ;
  233. ; extern TQ3Status Q3XSharedLibrary_Register(TQ3XSharedLibraryInfo *sharedLibraryInfo)
  234. ;
  235.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  236.         IMPORT_CFM_FUNCTION Q3XSharedLibrary_Register
  237.     ENDIF
  238.  
  239. ;
  240. ; extern TQ3Status Q3XSharedLibrary_Unregister(unsigned long sharedLibrary)
  241. ;
  242.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  243.         IMPORT_CFM_FUNCTION Q3XSharedLibrary_Unregister
  244.     ENDIF
  245.  
  246.  
  247. ; ******************************************************************************
  248. ; **                                                                             **
  249. ; **                                Posting Errors                                  **
  250. ; **                                                                             **
  251. ; **            You may only call these functions from within an extension         **
  252. ; **                                                                             **
  253. ; ****************************************************************************
  254.  
  255. ; 
  256. ; *    Q3XError_Post
  257. ; *    
  258. ; *    Post a QuickDraw 3D Error from an extension.
  259. ; 
  260.  
  261. ;
  262. ; extern void Q3XError_Post(TQ3Error error)
  263. ;
  264.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  265.         IMPORT_CFM_FUNCTION Q3XError_Post
  266.     ENDIF
  267.  
  268. ; 
  269. ; *    Q3XWarning_Post
  270. ; *    
  271. ; *    Post a QuickDraw 3D Warning, from an extension.  Note the warning code you
  272. ; *    pass into this routine must already be defined in the table above.
  273. ; 
  274.  
  275. ;
  276. ; extern void Q3XWarning_Post(TQ3Warning warning)
  277. ;
  278.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  279.         IMPORT_CFM_FUNCTION Q3XWarning_Post
  280.     ENDIF
  281.  
  282. ; 
  283. ; *    Q3XNotice_Post
  284. ; *    
  285. ; *    Post a QuickDraw 3D Notice, from an extension.  Note the notice code you
  286. ; *    pass into this routine must already be defined in the table above.
  287. ; 
  288.  
  289. ;
  290. ; extern void Q3XNotice_Post(TQ3Notice notice)
  291. ;
  292.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  293.         IMPORT_CFM_FUNCTION Q3XNotice_Post
  294.     ENDIF
  295.  
  296.  
  297.     IF TARGET_OS_MAC THEN
  298. ; 
  299. ; *    Q3XMacintoshError_Post
  300. ; *    
  301. ; *    Post the QuickDraw 3D Error, kQ3ErrorMacintoshError, and the Macintosh
  302. ; *    OSErr macOSErr. (Retrieved with Q3MacintoshError_Get)
  303. ; 
  304.  
  305. ;
  306. ; extern void Q3XMacintoshError_Post(OSErr macOSErr)
  307. ;
  308.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  309.         IMPORT_CFM_FUNCTION Q3XMacintoshError_Post
  310.     ENDIF
  311.  
  312.     ENDIF    ; TARGET_OS_MAC
  313.  
  314.     ENDIF ; __QD3DEXTENSION__ 
  315.  
  316.